docs: update Go versions, add hystrix-go deprecation notices#36
Conversation
- Update Cookiecutter example to show Go 1.25/1.24 instead of 1.19/1.20 - Add deprecation warnings for hystrix-go across Index, Integrations, Metrics, and Packages pages - Recommend failsafe-go as circuit breaker replacement
📝 WalkthroughWalkthroughUpdated documentation to reflect Hystrix-Go deprecation status and migration recommendations to failsafe-go. Refreshed Go image versions in Cookiecutter configuration from 1.19/1.20 to 1.25/1.24, and adjusted the default selection example. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
Packages.md (1)
52-53: LGTM! Clear deprecation notice.The heading clearly marks the package as deprecated, and the description provides actionable migration guidance.
Note: This file uses an inline link style
[failsafe-go](...)while Index.md and integrations.md use reference-style links. Consider using reference-style links consistently across all documentation files for easier maintenance.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@Packages.md` around lines 52 - 53, Update the inline markdown link in the "Hystrix Prometheus" section: replace the inline link `[failsafe-go](https://github.com/failsafe-go/failsafe-go)` with a reference-style link (e.g., `[failsafe-go][failsafe-go]`) and add the corresponding reference definition (`[failsafe-go]: https://github.com/failsafe-go/failsafe-go`) in the document's references area to match the reference-style link usage found in Index.md and integrations.md; ensure the heading "Hystrix Prometheus" and the deprecation text remain unchanged.howto/Metrics.md (1)
55-57: LGTM! Clear deprecation warning.The warning effectively communicates that Hystrix-Go is unmaintained and provides a migration path.
Note: This file uses an inline link style
[failsafe-go](...)while Index.md and integrations.md use reference-style links. Consider using reference-style links consistently across all documentation files for easier maintenance.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@howto/Metrics.md` around lines 55 - 57, The inline Markdown link "[failsafe-go](https://github.com/failsafe-go/failsafe-go)" in Metrics.md should be converted to the reference-style link used by Index.md and integrations.md: replace the inline link with a reference tag (e.g. "[failsafe-go][failsafe-go]") and add a corresponding reference entry (e.g. "[failsafe-go]: https://github.com/failsafe-go/failsafe-go") in the references section or bottom of the document so link style is consistent across docs.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@Cookiecutter.md`:
- Around line 59-61: Update the Go version choices in the Cookiecutter prompt to
reflect currently supported releases: replace the listed options "1.25" and
"1.24" (the lines showing "1 - 1.25" and "2 - 1.24") with "1.26" and "1.25", and
set the default choice to the newest supported release (1.26). Ensure any
accompanying text that displays the chosen/default version is updated
accordingly so templates and docs use Go 1.26 by default.
---
Nitpick comments:
In `@howto/Metrics.md`:
- Around line 55-57: The inline Markdown link
"[failsafe-go](https://github.com/failsafe-go/failsafe-go)" in Metrics.md should
be converted to the reference-style link used by Index.md and integrations.md:
replace the inline link with a reference tag (e.g. "[failsafe-go][failsafe-go]")
and add a corresponding reference entry (e.g. "[failsafe-go]:
https://github.com/failsafe-go/failsafe-go") in the references section or bottom
of the document so link style is consistent across docs.
In `@Packages.md`:
- Around line 52-53: Update the inline markdown link in the "Hystrix Prometheus"
section: replace the inline link
`[failsafe-go](https://github.com/failsafe-go/failsafe-go)` with a
reference-style link (e.g., `[failsafe-go][failsafe-go]`) and add the
corresponding reference definition (`[failsafe-go]:
https://github.com/failsafe-go/failsafe-go`) in the document's references area
to match the reference-style link usage found in Index.md and integrations.md;
ensure the heading "Hystrix Prometheus" and the deprecation text remain
unchanged.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 8e4d2fe7-6465-4aaf-abfa-b9a33ddb7f83
📒 Files selected for processing (5)
Cookiecutter.mdIndex.mdPackages.mdhowto/Metrics.mdintegrations.md
1 participant
Summary
Test plan
Summary by CodeRabbit
Release Notes